home *** CD-ROM | disk | FTP | other *** search
/ The Original Shareware 1.1 / The Original Shareware (WeMake CDs)(Volume 1.1)(CDs, Inc)(1993).iso / 16 / wptools.zip / WPTOOLS.DOC < prev   
Text File  |  1988-09-13  |  24KB  |  562 lines

  1.  
  2.  
  3.           Copyright (c) 1988 by David Seidman
  4.           September 5, 1988
  5.  
  6.  
  7.  
  8.           ╔══════════════════════════════════════════════════════════════╗
  9.           ║                                                              ║
  10.           ║                     WPTOOLS DOCUMENTATION                    ║
  11.           ║                                                              ║
  12.           ╚══════════════════════════════════════════════════════════════╝
  13.  
  14.  
  15.  
  16.  
  17.           I.  INTRODUCTION
  18.  
  19.           This shareware archive should contain four programs and this
  20.           documentation file.  The programs are: FIXPRE2.EXE, WPSNOOP2.EXE,
  21.           FONTLIST.EXE, and PRSFONTS.EXE.  Each is a utility for use with
  22.           WordPerfect Version 5.0 (WP5) files.  They are not useful in
  23.           connection with any earlier version of WordPerfect, and they may
  24.           not work correctly with any versions of WordPerfect later than
  25.           5.0.
  26.  
  27.  
  28.           Briefly, this is what the programs do:
  29.  
  30.           FIXPRE2:  Removes deleted (and optionally other) data packets
  31.                     from WP5 document files; it also removes deleted data
  32.                     packets from WP5 WP{WP}.SET files.  WordPerfect marks
  33.                     data packets as "deleted" as you edit or change the
  34.                     program's configuration, but may not necessarily
  35.                     physically delete them.  Removing deleted data packets
  36.                     from a document file with FIXPRE2 often facilitates
  37.                     changing the printer driver used with the file and will
  38.                     cure the uncontrolled growth in file size that can
  39.                     result from using the FASTSAVE option.  FIXPRE2 also
  40.                     shrinks setup files which have grown as you modify your
  41.                     setup.
  42.  
  43.  
  44.           WPSNOOP2: Reveals the structure of WP5 document file and .SET
  45.                     file prefixes.  In addition, WPSNOOP2 will identify the
  46.                     file type of numerous, although not all, files
  47.                     associated with recent WordPerfect Corporation (WPCorp)
  48.                     products.
  49.  
  50.  
  51.           FONTLIST: Lists the fonts contained in a WP5 document.
  52.  
  53.  
  54.           PRSFONTS: Lists the fonts available in a WP5 PRS file, along with
  55.                     the resources and groups associated with a particular
  56.                     PRS file.
  57.  
  58.  
  59.           Page 2   
  60.  
  61.  
  62.  
  63.           More detail on each program is given below, along with a
  64.           description of WP5 document file prefixes.
  65.  
  66.  
  67.           WPCorp has no connection with these programs, except that it
  68.           generously provided the technical information about file
  69.           structures necessary to write them.
  70.  
  71.  
  72.  
  73.  
  74.           II.  FIXPRE2
  75.  
  76.  
  77.           A.   WP5 Document Files
  78.  
  79.           WP5 document files have two sections:  the document prefix
  80.           (created by WP5), which contains document default settings and
  81.           information about fonts, styles, and other aspects of the
  82.           document; and the document itself (text and codes entered by the
  83.           user).  (More information about prefixes appears in a separate
  84.           section below.)  FIXPRE2 strips certain information out of the
  85.           prefix of a WP5 file; much of the information concerns printers
  86.           and fonts, while the balance of the information which gets
  87.           deleted has become obsolete through editing.  When you read the
  88.           stripped file created by FIXPRE2 back into WP5, WP5 restores
  89.           printer and font information by finding it in the appropriate PRS
  90.           files.  If you then save the file, it has all the proper
  91.           information.
  92.  
  93.           This sounds like a pretty pointless exercise.  Why would you want
  94.           to do it?  There are at least two reasons:
  95.  
  96.                (1)  Some people have had difficulty printing files after
  97.           changing printer drivers.  If the information left in the prefix
  98.           by the old printer driver is stripped out (by FIXPRE2), the file
  99.           is likely to print when a new driver is used.  So, if you got and
  100.           installed new printer drivers and a doc created under a previous
  101.           printer driver will not print or if you have a file created on
  102.           another machine and with another setup and the file will not
  103.           print, try cleaning out the old printer information with FIXPRE2.
  104.           Then read the file into WP5 with the new drivers installed.  You
  105.           will probably be able to print the file.
  106.  
  107.           The Update function in the WPCorp July, 1988 maintenance release
  108.           solves many printer driver problems of this kind, but it
  109.           apparently does not solve all problems related to changes of
  110.           printer drivers nor is it currently documented by WPCorp.
  111.  
  112.  
  113.           Page 3   
  114.  
  115.  
  116.                (2)  As you edit a file and change fonts, WP5 updates the
  117.           prefix with new information and marks old information as no
  118.           longer valid.  The FASTSAVE option in the WP5 configuration setup
  119.           (which you can choose) speeds disk saves of documents because it
  120.           does not delete from the prefix the old, invalid information.
  121.           Therefore, files which have been edited and then saved with
  122.           FASTSAVE tend to be larger than necessary, sometimes startlingly
  123.           so.  (If you SLOWSAVE a file, most (but not all) of the outdated
  124.           information is deleted from the prefix.)  FIXPRE2 physically
  125.           deletes the information marked as deleted (and, depending on how
  126.           you configure FIXPRE2, other information as well -- the valid
  127.           printer and font information, as noted above).
  128.  
  129.           Some users find FASTSAVE impractical, because of the resulting
  130.           substantial file sizes.  FIXPRE2 may make it practical to rely on
  131.           FASTSAVE.  You could set your defaults to FASTSAVE and then use
  132.           FIXPRE2 on the document from time to time to keep the file size
  133.           under control.  Because SLOWSAVE does more than delete
  134.           information from the file prefix, FIXPRE2 may be substantially
  135.           faster than SLOWSAVE on large files.
  136.  
  137.           Files which have been FASTSAVEd and then pared with FIXPRE2 will
  138.           initially be significantly smaller than files which have been
  139.           SLOWSAVEd (although this may not be true if you use the D option,
  140.           described below).  The files will get bigger when retrieved into
  141.           WP5 and saved with a new printer driver.  But the files will
  142.           usually remain somewhat smaller than even SLOWSAVEd files.
  143.  
  144.  
  145.           B.   WP5 Setup Files
  146.  
  147.           A WP5 setup file (WP{WP}.SET) also contains a number of data
  148.           packets.  As you change WordPerfect's configuration (without
  149.           making a new setup file), new data packets are added and old ones
  150.           marked as deleted.  It looks like WP5 never actually removes
  151.           these deleted data packets from the setup file.  FIXPRE2 will
  152.           remove them.  I have seen setup files shrink to 1/6th their size.
  153.           More substantial shrinking is presumably possible.
  154.  
  155.           C.   Using FIXPRE2
  156.  
  157.           Syntax:  FIXPRE2 [d:\path\]Infile [d:\path\]Outfile [Options]
  158.  
  159.              Infile is a WP5 file (FIXPRE2 can determine whether infile is
  160.              a document or a SET file).  Outfile (which is produced by
  161.              FIXPRE2) is an identical file except that certain information
  162.              has been eliminated.
  163.  
  164.  
  165.  
  166.           Page 4   
  167.  
  168.  
  169.  
  170.              Infile and Outfile must be different.  If Outfile already
  171.              exists, it will be overwritten without warning.
  172.  
  173.  
  174.           Options:
  175.  
  176.              The options, which are ignored if the input file is a SET
  177.              file, are indicated by letters.  Zero to two letters may
  178.              appear, and they should be adjacent to each other--no spaces
  179.              should separate them.  Two options (F and H) have no effect if
  180.              option D is used.  I know of no good reason for using options
  181.              F and H, but they may be worth trying if you have trouble
  182.              working with a FIXPREd file.
  183.  
  184.                   F:  Normally, FIXPRE2 substitutes different "document
  185.                   flags" for the "document flags" in Infile.  The F option
  186.                   tells FIXPRE2 to copy the Infile document flags to
  187.                   Outfile.
  188.  
  189.                   H:  Normally, FIXPRE2 does not copy the Infile "formatter
  190.                   hash table" to Outfile.  The H option tells FIXPRE2 to
  191.                   copy the formatter hash table to Outfile.
  192.  
  193.                   D:  Use this option if you are not having trouble
  194.                   printing a file, but simply want to remove deleted data
  195.                   packets.
  196.  
  197.                   When the D option is used, everything in the Infile
  198.                   prefix that is not outdated is copied to Outfile.
  199.  
  200.              None of these options affect the processing of setup files,
  201.              which are always process as if you had selected option D.
  202.  
  203.  
  204.           Function:
  205.  
  206.           FIXPRE2 strips information out of Infile.  By default, if Infile
  207.           is a WP5 document file, everything related to printers, styles,
  208.           the formatter hash table, and the deleted data packets is
  209.           stripped; in addition, FIXPRE2 provides Outfile with a generally
  210.           suitable document flags data packet (although this packet may not
  211.           be suitable in all cases).  As indicated above, some of the
  212.           information that has been stripped will be replaced when Outfile
  213.           is read into WP5.  Command line options permit the user to retain
  214.           more of the original information.  If Infile is a SET file,
  215.           deleted data packets are stripped.
  216.  
  217.  
  218.           Page 5   
  219.  
  220.  
  221.           III. WPSNOOP2
  222.  
  223.  
  224.           A.   What It Does
  225.  
  226.           WPSNOOP2 displays information concerning its input file.  If the
  227.           input file is not recognizable (from information internal to the
  228.           file) as a file related to a WPCorp product, WPSNOOP2 says so and
  229.           provides no other information.  If WPSNOOP2 recognizes the file,
  230.           it at least identifies the WPCorp product to which the file is
  231.           related.  If the file is recognized as a WordPerfect file (and it
  232.           is not for versions earlier than 5.0), WPSNOOP2 reports on the
  233.           type of file.  If the file is either a WP5 document file or a WP5
  234.           setup file, WPSNOOP2 reports a lot of other information.
  235.  
  236.           For a WP5 document file, WPSNOOP2 displays information about the
  237.           file prefix--in particular what sort of data packets are
  238.           contained within the prefix, where they are located and how large
  239.           they are. (Data packets are part of the organizational structure
  240.           of the file prefix; the term data packet comes directly from
  241.           WPCorp.)  Similar information is shown for a setup file.
  242.  
  243.  
  244.           B.   Using WPSNOOP2
  245.  
  246.           Syntax:  WPSNOOP2 [d:\path\]Infile
  247.  
  248.                     Infile may contain standard DOS wildcards.
  249.  
  250.                     Output is written to standard output -- normally the
  251.                     screen.  It will usually be desirable to redirect the
  252.                     output to the printer (e.g., WPSNOOP2 Infile >prn) or a
  253.                     file (e.g., WPSNOOP2 Infile >fname), or to pipe it to a
  254.                     program such as MORE (e.g, WPSNOOP2 Infile | more) or,
  255.                     far better, Vernon Buerg's LIST (e.g., WPSNOOP2 Infile
  256.                     | LIST /s)
  257.  
  258.  
  259.           Options:  None
  260.  
  261.  
  262.           Function:
  263.  
  264.           WPSNOOP2 displays at least very minimal information about any
  265.           Infile.  If Infile is a WP5 document file, WPSNOOP2 displays the
  266.           offset of the beginning of the document area of Infile, the
  267.           offsets within the file of the index blocks and the indexes, and
  268.           the information contained in the indexes (type of data packet
  269.           pointed to, length of data packet, and location of data packet).
  270.           It can be used simply to indicate what data packets a file
  271.           contains.  It can also be used to ease the reading of hex dumps
  272.  
  273.  
  274.           Page 6   
  275.  
  276.  
  277.           of WP5 files.  If Infile is a WP5 setup file, WPSNOOP2 displays
  278.           similar information about the entire file, which has essentially
  279.           the same structure as a WP5 document file prefix.
  280.  
  281.  
  282.           Limitations:
  283.  
  284.           WPSNOOP2 may not provide information about a few indexes.  The
  285.           end of useful information is signalled (generally) by an index
  286.           identifying a data packet of the "end of prefix" type.  All data
  287.           packets after the first such data packet are identical (or at
  288.           least provide no useful information).  WPSNOOP2 reports on only
  289.           the first of these, even though others may exist.  You can easily
  290.           tell if any exist:  if the index pointing to the "end of prefix"
  291.           data packet has an index number less than 4, enough additional
  292.           identical indexes exist so that the last of them is No. 4.  There
  293.           actually are no "end of prefix" data packets; indexes identifying
  294.           data packets of type "end of prefix" are, in a sense, fakes,
  295.           which merely indicate the end of the indexes.
  296.  
  297.  
  298.           IV.  FONTLIST
  299.  
  300.           FONTLIST displays a list of the fonts contained in a WP5 document
  301.           file.  This list is contained in the document's file prefix,
  302.           which FONTLIST reads.  This list may be particular useful if you
  303.           are not sure whether the fonts used in a document are available.
  304.  
  305.           Syntax:  FONTLIST [d:\path\]Infile
  306.  
  307.                     Infile is a WP5 document file.
  308.  
  309.                     Output is written to standard output -- normally the
  310.                     screen.  If a document uses many fonts, it will be
  311.                     desirable to redirect the output to the printer or a
  312.                     file, or pipe it to another program.
  313.  
  314.           Limitation:  FONTLIST will report on all fonts listed in the file
  315.           prefix's "font name string pool."  Some of these fonts may not
  316.           actually be used in the document.  For example, if you change
  317.           base fonts and then immediately change base fonts again, without
  318.           entering text, the first base font entered will be listed in the
  319.           string pool but not actually used.
  320.  
  321.           V.   PRSFONTS
  322.  
  323.           PRSFONTS lists the resources, groups, and fonts available in a
  324.           WP5 PRS file.  This is likely to be useful if you have a laser
  325.           printer and create numerous PRS files.
  326.  
  327.  
  328.  
  329.           Page 7   
  330.  
  331.  
  332.           Syntax:  PRSFONTS [d:\path\]Infile
  333.  
  334.                     Infile is a WP5 PRS file.
  335.  
  336.                     Output is written to standard output -- normally the
  337.                     screen.  If there are many fonts in the PRS file, it
  338.                     will be desirable to redirect the output to the printer
  339.                     or a file, or pipe it to another program.
  340.  
  341.  
  342.  
  343.           VI.  WP5 FILE PREFIXES
  344.  
  345.           This section provides some basic information about WP5 file
  346.           prefixes.  The information will give you a better understanding
  347.           of what FIXPRE2 and WPSNOOP2 do, and that understanding may help
  348.           you understand the situations in which FIXPRE2 is likely to be
  349.           useful.  You do not need to read this section in order to use
  350.           FIXPRE2, and the less technically inclined might wish to skip it.
  351.           A WP5 file document file has two areas:  the prefix area and the
  352.           document area.  The document area contains, roughly speaking, the
  353.           keystrokes you put into the file; it corresponds to the entire
  354.           file in earlier versions of WordPerfect, which did not use
  355.           prefixes.
  356.  
  357.           The prefix area begins with a "file prefix," which identifies the
  358.           file as a WP5 file, indicates where the document area begins (as
  359.           an offset in the file), and does little more.
  360.  
  361.           The rest of the prefix area consists of "data packets," (which
  362.           contain a wide variety of information about printers, defaults,
  363.           fonts, graphics, styles, and other matters) and indexes which
  364.           identify where in the prefix particular data packets are located.
  365.  
  366.           The indexes are organized in blocks.  Each block consists of a
  367.           "header index" and four other indexes.  The header index
  368.           identifies itself as such, provides some information which is the
  369.           same for every WP5 document file header index and is therefore
  370.           not interesting, and gives the offset in the file where the next
  371.           index block begins.
  372.  
  373.           Each of the other four indexes in a block identifies the type of
  374.           data packet to which it is an index, the length of that data
  375.           packet in bytes, and the offset in the file where the data packet
  376.           can be found.
  377.  
  378.           WP5 document files can have the following kinds of data packets:
  379.  
  380.  
  381.           Page 8   
  382.  
  383.  
  384.                Document summary
  385.                Document default values
  386.                Document flags
  387.                Font name string pool
  388.                Graphic image data
  389.                Formatter hash table
  390.                List of fonts used in document
  391.                Document printer information
  392.                Style
  393.                PS tables for fonts
  394.  
  395.           In addition, there may be deleted packets.
  396.  
  397.           The structure of a WP5 setup file is identical to that of a WP5
  398.           document file prefix, except that it has a different set of data
  399.           packets.
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.           Page 9   
  439.  
  440.  
  441.                                  LICENSE INFORMATION
  442.  
  443.  
  444.                WPTOOLS is not in the public domain.  Both the collection
  445.           and the individual programs are fully protected by copyright.
  446.  
  447.                You are granted without charge a license which permits (a)
  448.           use of the programs for a period of 30 days for evaluation and
  449.           testing; (b) making copies for distribution to others without
  450.           charge, provided the programs and the accompanying documentation
  451.           are distributed together and without modification; (c) posting
  452.           the programs, together with the accompanying documentation, on
  453.           electronic bulletin board systems.
  454.  
  455.                Use after the 30 day evaluation and testing period requires
  456.           payment of a license fee.  For a single copy (plus necessary
  457.           archival copies), to be used on only one computer at a time, the
  458.           fee is $15.00.  For your convenience, an invoice form is included
  459.           below.  For large quantities, discounts and site licenses are
  460.           available.  Write for information.  Any license for which payment
  461.           is properly made is valid for this version of WPTOOLS and all
  462.           subsequent versions.
  463.  
  464.                What do you get for your license fee?  Aside from permission
  465.           to use the programs and the warm feeling that you are not
  466.           violating the copyright laws, not very much, but a little.  If
  467.           you pay the license fee to me and tell me the version you have
  468.           (or if I can figure out what version you have), I will send you
  469.           the next version (unless the next version involves a trivial
  470.           change too small to worry you about).  After that, I will send
  471.           you further new versions if you send me a stamped, addressed
  472.           mailer and disk).  And if you let me know about any problems you
  473.           have with the programs, I will try to solve them.
  474.  
  475.                Users groups and other not-for-profit organizations may
  476.           distribute unmodified copies of WPTOOLS, together with its
  477.           accompanying documentation, for a fee to cover duplication and
  478.           related costs, but not to exceed $6.00.  Your payment of such a
  479.           fee does not eliminate the requirements concerning payment of a
  480.           license fee.  Certain organizations may have been granted
  481.           permission to distribute the program for a fee larger than $6.00,
  482.           the larger fee to include the license fee for a single copy.  If
  483.           the organization from which you received a copy of the program
  484.           has been granted that permission, it should tell you so.
  485.  
  486.                The United States Department of Justice is granted a
  487.           license, without payment of fee, for all official use of WPTOOLS.
  488.  
  489.  
  490.  
  491.  
  492.  
  493.           Page 10   
  494.  
  495.  
  496.                               WARRANTY INFORMATION
  497.  
  498.                These programs are distributed without warranties of any
  499.           kind, express or implied, including, but not limited to, the
  500.           implied warranties of merchantability and fitness for a
  501.           particular purpose.
  502.  
  503.                No representation or other affirmation of fact, including
  504.           but not limited to statements regarding suitability for use, or
  505.           performance of the programs, shall be or be deemed a warranty by
  506.           the licensor for any purpose, nor give rise to any liability or
  507.           obligation of the licensor whatever.
  508.  
  509.                In particular, no statement in program documentation shall
  510.           be deemed a representation or warranty that the programs will
  511.           perform in any particular manner, or perform in any manner
  512.           whatsoever, or that the programs are suitable for any particular
  513.           use or any use at all.
  514.  
  515.  
  516.  
  517.                                        INVOICE
  518.  
  519.  
  520.  
  521.           David Seidman
  522.           2737 Devonshire Pl. NW
  523.           Washington, DC 20008
  524.  
  525.                                                   DATE:
  526.  
  527.           SOLD TO:
  528.  
  529.               
  530.               
  531.               
  532.  
  533.  
  534.           ┌──────────────────────────────────────┬────────────────────────┐
  535.           │ Description                          │     Price              │
  536.           │                                      │                        │
  537.           ├──────────────────────────────────────┼────────────────────────┤
  538.           │                                      │                        │
  539.           │ License for WPTOOLS                  │      $   15.00         │
  540.           │                                      │                        │
  541.           │ additional licenses @ $15.00         │       _____.__         │
  542.           │                                      │                        │
  543.           │                                      │                        │
  544.           │                                      │                        │
  545.           │                                      │                        │
  546.           └──────────────────────────────────────┴────────────────────────┘
  547.  
  548.                                           Total:       $_____.__
  549.            D.C. Residents add 6% D.C. Sales Tax:          ___.__
  550.  
  551.                                    Total Charge:       $_____.__
  552.  
  553.  
  554.  
  555.           Make checks payable to David Seidman.  Please mark checks
  556.           "WPTOOLS".
  557.  
  558.           ------------------------------------------------------------
  559.           WordPerfect is a trademark of the WordPerfect Corporation.
  560.  
  561.  
  562.